/*
 * Copyright 2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.internal.vfs.watch;

import org.gradle.internal.vfs.SnapshotHierarchy;

import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.function.Predicate;

public interface FileWatcherRegistryFactory {
    /**
     * Start watching the given snapshot hierarchy.
     *
     * @throws WatchingNotSupportedException when the native watcher is unable to watch the given snapshot hierarchy.
     */
    FileWatcherRegistry startWatching(SnapshotHierarchy snapshotHierarchy, Predicate<String> watchFilter, Collection<File> mustWatchDirectories, FileWatcherRegistry.ChangeHandler handler) throws IOException, WatchingNotSupportedException;
}
